/*
 * Copyright 2025 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.keycloak.models.workflow;

import org.keycloak.provider.Provider;

public interface WorkflowStepProvider extends Provider {

    /**
     * Run this workflow step.
     *
     * @param context the workflow execution context
     */
    void run(WorkflowExecutionContext context);

    /**
     * Returns the message or the text that should be used as the subject of the email when notifying the user about this step.
     *
     * @return the notification subject, or {@code null} if the default subject should be used
     */
    default String getNotificationSubject() {
        return null;
    }

    /**
     * Returns the message or the text that should be used as the body of the email when notifying the user about this step.
     *
     * @return the notification body, or {@code null} if the default subject should be used
     */
    default String getNotificationMessage() {
        return null;
    }
}
